Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): correct type for opts.read #37626

Closed
wants to merge 1 commit into from
Closed

Conversation

tieppt
Copy link
Contributor

@tieppt tieppt commented Jun 17, 2020

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

We have 4 decorators: ViewChild, ViewChildren, ContentChild, ContentChildren. They have accept extra info to read a token, but the typing for opts.read is not correct. It set to Boolean right now.

Issue Number: N/A

What is the new behavior?

Correct type of opts.read to any.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@pullapprove pullapprove bot requested a review from atscott June 17, 2020 15:47
The ContentChildren decorator has a metadata property named "read" which
can be used to read a different token from the queried elements. The
documentation incorrectly says "True to read..." when it should say
"Used to read...".
@atscott atscott added the action: merge The PR is ready for merge by the caretaker label Jun 18, 2020
@atscott atscott added the target: patch This PR is targeted for the next patch release label Jun 18, 2020
@mhevery mhevery closed this in 1d844b9 Jun 18, 2020
mhevery pushed a commit that referenced this pull request Jun 18, 2020
The ContentChildren decorator has a metadata property named "read" which
can be used to read a different token from the queried elements. The
documentation incorrectly says "True to read..." when it should say
"Used to read...".

PR Close #37626
ngwattcos pushed a commit to ngwattcos/angular that referenced this pull request Jun 25, 2020
The ContentChildren decorator has a metadata property named "read" which
can be used to read a different token from the queried elements. The
documentation incorrectly says "True to read..." when it should say
"Used to read...".

PR Close angular#37626
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jul 19, 2020
@tieppt tieppt deleted the patch-1 branch July 21, 2020 17:07
profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 2020
The ContentChildren decorator has a metadata property named "read" which
can be used to read a different token from the queried elements. The
documentation incorrectly says "True to read..." when it should say
"Used to read...".

PR Close angular#37626
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants